<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    
<html>

<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-language" content="en" />
<meta name="Keywords" content="progress,ant,compilation,automated,task,querret,apache,build tools,roundtable" />
<meta name="Description" content="PCT is set of ANT tasks designed to compile Progress procedures among others things" />
<meta name="revisit-after" content="30 days" />
<meta name="DC.Language" content="en" />
<title>PCT documentation - PCTConnection type</title>
<link rel="stylesheet" type="text/css" href="style.css" media="screen" title="Normal" />
</head>
<body>

<div class="Main">

<div class="Bandeau">
  <span id="sflogo">
    <a href="http://sourceforge.net"><img id="sflogoimg" alt="SourceForge.net Logo" height="31" width="88" src="http://sourceforge.net/sflogo.php?group_id=%3Cb%3E85743%3C/b%3E&amp;amp;type=1"/></a>
  </span>
  Progress&reg; OpenEdge&reg; Compilation Tools
</div>

<div class="Menu">
  <a href="index.html">Overview</a>
  :: <a href="download.html">Download</a>
  :: <a href="screenshots.html">Screenshots</a>
  :: <span class="selected">Documentation</span>
  :: <a href="javadoc/index.html">JavaDoc</a>
  :: <a href="links.html">Links</a>
</div>

@RIGHT_BANNER@

<div class="Text">
<h1>PCTConnection type</h1>

<h2>Description</h2>
<p>
Adds a database connection
</p>

<h2>Parameters</h2>
<table class="params">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Type</th>
<th>Requirement</th>
<th>Default value</th>
</tr>
<tr>
<td>dbName</td>
<td>Database physical name</td>
<td align="center">String</td>
<td align="center" rowspan="2">At least one of these is required.</td>
<td>No default value</td>
</tr>
<tr>
<td>paramFile</td>
<td>Parameter file (-pf parameter). If paramFile is set and dbName is unset, paramFile is always in first position.
If both paramFile and dbName are set, dbName is in first position and paramFile in second position.
Don't define multiple database connections in a single paramFile, this can lead to unexpected behavior.</td>
<td align="center">File</td>

<td>No default value</td>
</tr>
<tr>
<td>dbDir</td>
<td>Directory where database is physically located (relative to baseDir)</td>
<td align="center">File</td>
<td align="center">Optional</td>
<td>No default value</td>
</tr>
<tr>
<td>dbPort</td>
<td>TCP port to connect to (-S parameter)</td>
<td align="center">String</td>
<td align="center">Optional</td>
<td>No default value</td>
</tr>
<tr>
<td>Protocol</td>
<td>Protocol to use (-N parameter)</td>
<td align="center">String</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>LogicalName</td>
<td>Logical name for the database (-ld parameter)</td>
<td align="center">String</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>CacheFile</td>
<td>Name of the binary cache file (-cache parameter)</td>
<td align="center">File</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>DataService</td>
<td>Dataservice (-DataService parameter)</td>
<td align="center">String</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>DbType</td>
<td>Database type (Oracle, SQL Server, ...) (-dt parameter)</td>
<td align="center">String</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>HostName</td>
<td>Host name where the database resides (-H parameter)</td>
<td align="center">String</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>UserName</td>
<td>Login (-U parameter)</td>
<td align="center">String</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>Password</td>
<td>Password (-P parameter)</td>
<td align="center">String</td>
<td align="center">No</td>
<td>No default value</td>
</tr>
<tr>
<td>ReadOnly</td>
<td>Open the database in read-only mode (-RO parameter)</td>
<td align="center">Boolean</td>
<td align="center">No</td>
<td>No</td>
</tr>
<tr>
<td>SingleUser</td>
<td>Open the database in single-user mode (-1 parameter)</td>
<td align="center">Boolean</td>
<td align="center">No</td>
<td>No</td>
</tr>
</table>

<h2>Parameters as nested elements</h2>
<h3>PCTAlias (<a href="PCTAlias.html">com.phenix.pct.PCTAlias</a>)</h3>
<p>
Adds an alias to a connection
</p>

<h2>Examples</h2>
<pre>
&lt;PCTRun ...&gt;
  &lt;PCTConnection dbName="foo" logicalName="bar" paramFile="conf/param.pf"/&gt;
&lt;/PCTRun&gt;
</pre>
<p>
On the command line will be appended the following parameters : <code>-db foo -pf conf/param.pf -ld bar</code>
</p>
</div>

</div>

@ANALYTICS@</body>
</html>
